home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1995 #1 / Amiga Plus 1995 #1.iso / fish-disketten / fish_941-950 / d946 / yass / yass.doc < prev    next >
Text File  |  1994-12-13  |  9KB  |  249 lines
  1.                             Yass V1.1 - Manual
  2.                             ~~~~~~~~~~~~~~~~~~
  3.  
  4. NAME
  5.      Yass - Yet Another Screen Selector
  6.  
  7.  
  8. DESCRIPTION
  9.      Yass is a new Screen-Selector Commodity for Amigas with OS2.0
  10.      or higher. Here's a rundown of Yass' features:
  11.  
  12.      o Completely controllable via keyboard.
  13.        (of course you can use your mouse, if you really want to).
  14.  
  15.      o Shows Screens and Windows (option).
  16.  
  17.      o Shows PublicScreenname or ScreenTitle (option).
  18.  
  19.      o Ability to change the default Public screen.
  20.  
  21.      o Opens window even on non-public screens (option).
  22.  
  23.      o Font-sensitive.
  24.  
  25.      o Resizeable window.
  26.  
  27.  
  28. COPYRIGHT
  29.      Yass is freely distributable.
  30.      Yass is free to be spread on public-domain and shareware disks
  31.      especially on Fred Fish's AmigaLibDisks, as long as they are sold 
  32.      for a reasonable charge that is less than US $6 or DM 8.- .
  33.      For use in commercial products the permission of the authors is required.
  34.      Yass may be copied and distributed via electronic networks such
  35.      as the Internet, also it may be held available on anonymous ftp-servers,
  36.      mail-boxes or BBS's.
  37.      The Copyright is still by the Author.
  38.  
  39.  
  40. AUTHOR
  41.      Albert Schweizer
  42.      Kelterstr. 9
  43.      71032 Böblingen
  44.      Germany
  45.  
  46.      Internet: schweizr@rhds01.rz.fht-esslingen.de
  47.  
  48.      Ps. IF YOU LIKE THIS PROGRAM A LOT, SEND ME A POSTCARD !!
  49.      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50.  
  51.  
  52. REQUIREMENTS
  53.      o Any Amiga with Kickstart 2.04 (V37) or higher
  54.  
  55.  
  56. STARTING
  57.      Yass is a COMMODITY, therefore it _only_ runs under WB Release
  58.      2.0 (V37.175) and newer. A Commodity is normally started in the
  59.      "SYS:WBStartup" drawer. So it will be automatically started on the
  60.      workbench startup (LoadWB, usually in "S:Startup-Sequence").
  61.      So, just copy "Yass" and "Yass.info" to "SYS:WBStartup", or
  62.      click and move the icon to the drawer.
  63.  
  64.      To get Yass started without rebooting now, double-click the icon.
  65.      If the Tool Types weren't changed yet, a window shows up. Double-click
  66.      once more, if the window doesn't show up.
  67.  
  68.      You can start Yass from the CLI or another Shell.
  69.      For example you can start Yass in the S:User-Startup:
  70.          Run >NIL: <NIL: Yass CX_POPUP=NO
  71.  
  72.  
  73. OPTIONS - TOOL TYPES
  74.      Yass knows some ToolTypes which can either be located within the 
  75.      .info file or may be issued on the command line. The syntax should 
  76.      be of the form ToolType=Value.
  77.  
  78.      Here are the ToolTypes the program recognizes.
  79.  
  80.      DONOTWAIT
  81.                  When started from WBStartup, let
  82.                  WB know that it doesn't have to wait
  83.                  for Yass.
  84.  
  85.      CX_PRIORITY=<-128 - 129>
  86.                  Priority in "commodities.library"'s queue
  87.                  Default: 0
  88.  
  89.      CX_POPUP=<YES | NO>
  90.                  When Yass is started, the Screenlist-Window may show
  91.                  up when set to 'YES' or any (!) other String
  92.                  than 'NO'.
  93.                  Default: YES
  94.  
  95.      CX_POPKEY=<Hot Key>
  96.                  The hot key opens the Screenlist-Window of Yass.
  97.                  Default: Shift Escape
  98.  
  99.      EXTPOPUP=<YES | NO>
  100.                  Yass' Screenlist-Window will popup on every screen
  101.                  (even on non-public screens !) when set to 'YES' or any 
  102.                  other string than 'NO'. See WARNINGS for more information.
  103.                  Default: YES
  104.  
  105.      SHOWWINDOWS=<YES | NO>
  106.                  The Screenlist will also contain windows when set 
  107.                  to 'YES' or any other string than 'NO'.
  108.                  Default: NO
  109.  
  110.      LEFT=<startup X-position>
  111.                  Yass' Screenlist-Window x-position at startup.
  112.                  Default: 100
  113.  
  114.      TOP=<starup Y-position>
  115.                  Yass' Screenlist-Window y-position at startup.
  116.                  Default: 100
  117.  
  118.      WIDTH=<starup width min. 180>
  119.                  Yass' Screenlist-Window width at startup.
  120.                  (width is font-sensitive !!
  121.                  The relation is 1:1 for topaz.8)
  122.                  Default: 270
  123.  
  124.      HEIGHT=<starup height min. 120>
  125.                  Yass' Screenlist-Window height at startup.
  126.                  (height is font-sensitive !!
  127.                  The relation is 1:1 for topaz.8)
  128.                  Default: 133
  129.  
  130.  
  131. USAGE
  132.      When the CX_POPUP Tooltype is set to 'YES' and Yass is being started
  133.      or when the hot key was pressed, the Screenlist-Window shows up.
  134.  
  135.      SCREENLIST WINDOW (V39 style):
  136.         Keys in "[]" are short-cuts. With them you can access the gadgets
  137.         with the keyboard w/o moving the mouse.
  138.  
  139.           +-+--------------------------+-+-+
  140.           |o| Yass <Shift Esc>         |Q|H|
  141.           +-+--------------------------+-+-+
  142.           |                                |
  143.           |           ScreenList           |
  144.           |                                |    ScreenList:
  145.           | +--------------------------+-+ |
  146.           | |Workbench                 | | |    Use mouse or [SHIFT]+
  147.           | |  -Work 77 % voll, 43 M fr| | |    CURSOR-UP/DOWN/LEFT/RIGHT
  148.           | |  -AmigaShell             | | |    to select window/screen. 
  149.           | |CygnusEdScreen1           | | |
  150.           | |                          +-+ |
  151.           | |                          |A| |
  152.           | |                          |V| |
  153.           | +--------------------------+-+ |
  154.           |                                |
  155.           |     Default [P]ublicScreen     |    CycleGadget:
  156.           |                                |    
  157.           | +---+------------------------+ |    The value inside the
  158.           | | G |      Workbench         | |    Cycle-Gadget is set to
  159.           | +---+------------------------+ |    the current default
  160.           |                                |    Public screen.
  161.           | +----------+      +----------+ |
  162.           | | [S]elect |      | [C]ancel | |
  163.           | +----------+      +----------+ |    
  164.           |                                |
  165.           +------------------------------+-+
  166.           |                              |/|
  167.           +------------------------------+-+
  168.  
  169.      GADGET-KEYBOARD-CONTROL
  170.         o To select next/previous ScreenList-Item use CURSOR-UP/DOWN.
  171.  
  172.         o If ShowWindows-Option is enabled use CURSOR-LEFT/RIGHT to
  173.           select next/previous Screen.
  174.  
  175.         o Press 'p' to change the default Public screen.
  176.           Use SHIFT to alter the entry in the other direction.
  177.  
  178.         o Press 's' or <return> to activate selected screen/window.
  179.  
  180.         o Press 'c' or <esc> to close the window w/o action.
  181.  
  182.  
  183.      MENU ITEMS:
  184.         Menu items can also be used via the keyboard, use the shown
  185.         Command Keys.
  186.   
  187.         +---------+
  188.         | Project |
  189.         +-+-------+--------+ 
  190.           |Screenname     »|
  191.           |           +------------+   
  192.           |           |  Title    T|    Show Screentitle      
  193.           |           |/ PubName  P|    Show Public screen name 
  194.           |           +------------+  
  195.           |/ Ext. Popup   E|            Enables extended popup-mode.
  196.           |  Show Windows W|            Include windows in Screenlist.
  197.           |----------------|
  198.           |About          ?|            Shows up the version and Copyright.
  199.           |----------------|
  200.           |Quit           Q|            Exit Yass.
  201.           +----------------+      
  202.  
  203.  
  204. WARNINGS
  205.      If you use the EXTENDED POPUP-MODE, Yass will try to open its window
  206.      on every Screen (even on non-public screens). This could cause problems
  207.      if a program trys to close the screen while Yass' window is open.
  208.      It might be possible that situations emerge which confuze the OS and
  209.      lead to a software failure. 
  210.  
  211.      In other words don't experiment with it when you haven't saved that
  212.      file you are editing yet. Remember you use this at your own risk!
  213.  
  214.  
  215. TESTING
  216.      This program was developed on an A4000/040 and was tested on the 
  217.      following configurations:
  218.  
  219.      o A1000, 120 MB IDE HD, Multivision FF, 512 KB Chip-RAM and
  220.        2 MB Fast-RAM. (OS2.1+OS3.0)
  221.  
  222.      o A2000, '030 25MHz, 200 MB SCSI HD, oMniBus-Gfx-System, 1 MB Chip-RAM
  223.        and some MB 32Bit-Fast-RAM. (OS3.0)
  224.  
  225.      o A3000 25MHz, 1 GB SCSI HD, oMniBus-Gfx-System, 2 MB Chip-RAM and 
  226.        some MB Fast-RAM. (OS3.0)
  227.  
  228.      o A4000/040, 2x 170MB IDE HDs, oMniBus-Gfx-System, 2 MB Chip-RAM 
  229.        and 8 MB Fast-RAM. (OS3.0)
  230.  
  231.      On all these configuration the program seems to work fine, so I guess 
  232.      you can run it on almost any machine (with a bit of spare memory).
  233.  
  234.  
  235. TODO
  236.      If you have any suggestions, let me know!
  237.  
  238.  
  239. BUGS
  240.      Tell me about any you find!
  241.  
  242.  
  243. RELEASE NOTES
  244.      V0.xß - Internal releases, for betatesters only. DON'T USE.
  245.  
  246.      V1.0  - First Public release
  247.  
  248.      V1.1  - Fixed nasty resize-Bug + some internal changes.
  249.